<html>

<head>
<meta http-equiv="Content-Language" content="en-us">
<title>ShutdownExec Task</title>
<link rel="stylesheet" type="text/css" href="../stylesheets/antmanual.css">
</head>

<body>

<h2><a name="exec">ShutdownExec</a></h2>
<h3>Description</h3>
<p>Shutdown  a system command on the specified remote host or hosts.</p>
<p>The string 'dir + executable + args ' as a key will be stored in a process repository  after the command is executed on the remote host.</p>
<p>That key is a unique identifier to indicate each process started on the remote host.
</p>
<p>So, to shutdown the executable, you only need to provide the <strong>dir</strong>, <strong>executable</strong> and <strong>args</strong> for the specified host or hosts. </p>
<h4>Parameters</h4>
<table border="1" cellpadding="2" cellspacing="0">
  <tr>
    <td valign="top"><b>Attribute</b></td>
    <td valign="top"><b>Description</b></td>
    <td align="center" valign="top"><b>Required</b></td>
  </tr>
  <tr>
    <td valign="top">executable</td>
    <td valign="top">the command to execute without any command line
      arguments.</td>
    <td align="center">YES</td>
  </tr>
  <tr>
    <td valign="top">dir</td>
    <td valign="top">the directory in which the command should be executed.if it is not an absolute dir, the host's base dir will be instered before this dir. </td>
    <td align="center" valign="top">No</td>
  </tr>
  <tr>
    <td valign="top">timeout</td>
    <td valign="top">Stop the command if it doesn't finish within the
      specified time (given in milliseconds).</td>
    <td align="center" valign="top">No</td>
  </tr>
  <tr>
    <td valign="top">failonerror</td>
    <td valign="top">Stop the buildprocess if the command exits with a
      return code signaling failure. Defaults to false.</td>
    <td align="center" valign="top">No</td>
  </tr>
  <tr>
    <td valign="top">hostref</td>
    <td valign="top">reference a remote host.if hostref or hostsetref both not specified, the command will execute locally </td>
    <td valign="top" align="center">NO</td>
  </tr>
  <tr>
    <td valign="top">hostsetref</td>
    <td valign="top">reference remote hosts. if hostref or hostsetref both not specified, the command will execute locally </td>
    <td valign="top" align="center">NO</td>
  </tr>
  <tr>
    <td valign="top">transmit</td>
    <td valign="top">whether or not transmit the command to the remote host, default value is YES, if set to NO, just print the command in standard output. </td>
    <td align="center" valign="top">No</td>
  </tr>
</table>
<h3>Parameters specified as nested elements</h3>
<h4>arg</h4>
<p>Command line arguments should be specified as nested
<code>&lt;arg&gt;</code> elements. See <a
href="../using.html#arg">Command line arguments</a>.</p>
<a name="redirector"><h4>Examples</h4></a>
<blockquote>
  <pre>  &lt;shutdownexec dir=&quot;/tmp&quot; executable=&quot;ping&quot; host=&quot;greatwall&quot;&gt;<br>     &lt;arg line=&quot;localhost -n 3&quot;/&gt;<br>  &lt;/shutdowneexec&gt;</pre>
</blockquote>
<hr>
<p align="center">Copyright &copy; 2005 Dant Organization. All rights Reserved.</p>

</body>
</html>

